improve: use the default list methods with read-cache-after-write consistency by csviri · Pull Request #3336 · operator-framework/java-operator-sdk

csviri · 2026-05-07T11:59:05Z

Remove the index and list related methods "strong consistency variant".

The rational behind this change is that the user either uses read-cache-after-write consistency feature,
than the "strong read" should be used. If on the other hand tha feature,
is not used, the current implementation does not impose any overhead.

In addition to that strong consistency is not a good name, we call this feature
as read-cache-after-write consistency, that might be too long though.

Adds ghost resource handling for keys().

Add also missing javadocs.

Signed-off-by: Attila Mészáros a_meszaros@apple.com

Copilot

Pull request overview

This PR removes the “strong consistency” list/index variants by folding read-cache-after-write consistency behavior into the default list(...) / byIndexStream(...) methods on ManagedInformerEventSource, and updates tests to use the new API surface.

Changes:

Replaced listWithStrongConsistency(...) with list(...) implementations that merge informer results with the temporary cache for read-cache-after-write consistency.
Replaced byIndexStreamWithStrongConsistency(...) with byIndexStream(...) and updated byIndex(...) to return merged results.
Updated informer event source tests to call the renamed/default methods.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.

File	Description
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/ManagedInformerEventSource.java	Removes “strong consistency” variants, makes default list/index methods merge with the temp cache, and adjusts index lookup behavior.
operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSourceTest.java	Updates tests to use `list(...)` / `byIndexStream(...)` instead of the removed “strong consistency” methods.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

+  @Override
+  public List<R> byIndex(String indexName, String indexKey) {
    return mergeWithWithTempCacheResources(
-        manager().byIndexStream(indexName, indexKey), indexName, indexKey);
+            manager().byIndexStream(indexName, indexKey), indexName, indexKey)
+        .toList();


Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

xstefank

Do we have a policy that public methods should be first deprecated before they are removed?

csviri · 2026-05-07T15:44:53Z

Do we have a policy that public methods should be first deprecated before they are removed?

This is against next branch and code that is not released yet. Otherwise we deprecate methods, and remove them in the next major version.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 8 comments.

  public Stream<R> list(String namespace, Predicate<R> predicate) {
-    return manager().list(namespace, predicate);
+    return mergeWithWithTempCacheResources(
+        manager().list(namespace, predicate), namespace, predicate);
  }


+  @Override
+  public Stream<R> byIndexStream(String indexName, String indexKey) {
    return mergeWithWithTempCacheResources(
-        manager().list(namespace, predicate), namespace, predicate);
-  }
-
-  /**
-   * Like {@link #list(Predicate)} but for read-cache-after-write consistency. This is useful when
-   * resources are updated using {@link
-   * io.javaoperatorsdk.operator.api.reconciler.ResourceOperations}.
-   */
-  public Stream<R> listWithStrongConsistency(Predicate<R> predicate) {
-    return mergeWithWithTempCacheResources(cache.list(predicate), null, predicate);
+        manager().byIndexStream(indexName, indexKey), indexName, indexKey);
  }


+  /**
+   * {@inheritDoc}
+   *
+   * <p>This implementation is read-cache-after-write consistent. Results are merged with the
+   * temporary resource cache to ensure recently written resources are reflected in the output.
+   */


  public Stream<R> list(String namespace, Predicate<R> predicate) {
-    return manager().list(namespace, predicate);
+    return mergeWithWithTempCacheResources(
+        manager().list(namespace, predicate), namespace, predicate);
  }

+  /**
+   * {@inheritDoc}
+   *
+   * <p>This implementation is read-cache-after-write consistent. Results are merged with the
+   * temporary resource cache to ensure recently written resources are reflected in the output.
+   */
  @Override
  public Stream<R> list(Predicate<R> predicate) {
-    return cache.list(predicate);
-  }
-
-  @Override
-  public List<R> byIndex(String indexName, String indexKey) {
-    return manager().byIndex(indexName, indexKey);
-  }
-
-  public Stream<R> byIndexStream(String indexName, String indexKey) {
-    return manager().byIndexStream(indexName, indexKey);
+    return mergeWithWithTempCacheResources(cache.list(predicate), null, predicate);
  }

  /**
-   * Like {@link #list(String, Predicate)} but for read-cache-after-write consistency. This is
-   * useful when resources are updated using {@link
-   * io.javaoperatorsdk.operator.api.reconciler.ResourceOperations}.
+   * {@inheritDoc}
+   *
+   * <p>This implementation is read-cache-after-write consistent. Results are merged with the
+   * temporary resource cache to ensure recently written resources are reflected in the output.
   */
-  public Stream<R> listWithStrongConsistency(String namespace, Predicate<R> predicate) {
+  @Override
+  public Stream<R> byIndexStream(String indexName, String indexKey) {
    return mergeWithWithTempCacheResources(
-        manager().list(namespace, predicate), namespace, predicate);
-  }
-
-  /**
-   * Like {@link #list(Predicate)} but for read-cache-after-write consistency. This is useful when
-   * resources are updated using {@link
-   * io.javaoperatorsdk.operator.api.reconciler.ResourceOperations}.
-   */
-  public Stream<R> listWithStrongConsistency(Predicate<R> predicate) {
-    return mergeWithWithTempCacheResources(cache.list(predicate), null, predicate);
+        manager().byIndexStream(indexName, indexKey), indexName, indexKey);
  }


+    return mergeWithWithTempCacheResources(
+        manager().list(namespace, predicate), namespace, predicate);


…sistency Remove the index and list related methods "strong consistency variant". The rational behind this change is that the user either uses read-cache-after-write consistency feature, than the "strong read" should be used. If on the other hand tha feature, is not used, the current implementation does not impose any overhead. In addition to that strong consistency is not a good name, we call this feature as read-cache-after-write consistency, that might be too long though. Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (2)

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/ManagedInformerEventSource.java:1

In keys(), manager() is invoked multiple times and manager().contains(k) is called once per temp key, which can be costly and can also be inconsistent if manager() is not stable. Consider capturing var m = manager(); once and de-duplicating without per-key lookups (e.g., concatenate the two key streams and use distinct(), or collect manager keys into a Set once and then filter temp keys against that set). Tradeoff: distinct()/collecting requires buffering keys, but avoids N extra contains() calls.

/*

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/ManagedInformerEventSource.java:1

If InformerManager provides a non-stream byIndex(...) that is more efficient than byIndexStream(...) (as it was used previously), consider using it and streaming the returned list only for merging/filtering. This can reduce stream overhead and avoid multiple stream traversals depending on the manager implementation.

/*

+  private static <R extends HasMetadata> Predicate<R> filterResourceByNamespaceAndPredicate(
+      String namespace, Predicate<R> predicate) {
+    return r -> {
+      if (namespace != null) {
+        var res = Optional.of(r).map(ns -> ns.equals(namespace)).orElse(false);
+        if (!res) return false;
      }
-      // we check if the ghost resource is part of the index
-      tempResourceStream =
-          tempResources.values().stream().filter(r -> indexer.apply(r).contains(indexKey));
-    } else {
-      tempResourceStream = tempResources.values().stream();
-    }
-    return Stream.concat(tempResourceStream, upToDateList.stream());
+      if (predicate != null) {
+        return predicate.test(r);
+      }
+      return true;
+    };
  }


  public Stream<R> list(String namespace, Predicate<R> predicate) {
-    return manager().list(namespace, predicate);
+    return mergeWithTempCacheForList(manager().list(namespace, predicate), namespace, predicate);
  }


+  private Stream<R> mergeWithTempCacheForList(
+      Stream<R> stream, String namespace, Predicate<R> predicate) {
+    if (!comparableResourceVersions || temporaryResourceCache.isEmpty()) {
+      return stream.filter(filterResourceByNamespaceAndPredicate(namespace, predicate));
+    }


+            .filter(filterResourceByNamespaceAndPredicate(namespace, predicate))
+            .toList();


Copilot AI review requested due to automatic review settings May 7, 2026 11:59

openshift-ci Bot requested review from metacosm and xstefank May 7, 2026 11:59

csviri requested review from metacosm, shawkins and xstefank and removed request for metacosm and xstefank May 7, 2026 11:59

Copilot started reviewing on behalf of csviri May 7, 2026 11:59 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

csviri requested a review from Copilot May 7, 2026 12:12

Copilot started reviewing on behalf of csviri May 7, 2026 12:14 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

csviri force-pushed the list-improve branch from 5bf2cfc to 2bfb6da Compare May 7, 2026 13:03

csviri requested a review from Copilot May 7, 2026 13:07

Copilot started reviewing on behalf of csviri May 7, 2026 13:08 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

xstefank approved these changes May 7, 2026

View reviewed changes

csviri force-pushed the next branch from d5157bd to 0297680 Compare May 11, 2026 11:49

csviri force-pushed the list-improve branch from 2bfb6da to b538996 Compare May 11, 2026 14:00

csviri requested a review from Copilot May 11, 2026 14:04

Copilot started reviewing on behalf of csviri May 11, 2026 14:08 View session

Copilot AI reviewed May 11, 2026

View reviewed changes

csviri requested a review from Copilot May 12, 2026 16:07

csviri and others added 5 commits May 12, 2026 18:07

wip

c620b92

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

65ff7c7

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Potential fix for pull request finding

112fb15

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

9ea901a

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

csviri and others added 3 commits May 12, 2026 18:07

Apply suggestions from code review

5b511ab

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

f8fb61f

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

c1216ce

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

csviri force-pushed the list-improve branch from f9372f2 to c1216ce Compare May 12, 2026 16:08

Copilot AI reviewed May 12, 2026

View reviewed changes

Copilot started reviewing on behalf of csviri May 12, 2026 16:34 View session

		return mergeWithWithTempCacheResources(
		manager().list(namespace, predicate), namespace, predicate);

		.filter(filterResourceByNamespaceAndPredicate(namespace, predicate))
		.toList();

Conversation

csviri commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xstefank left a comment

Choose a reason for hiding this comment

Uh oh!

csviri commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

csviri commented May 7, 2026 •

edited

Loading

csviri commented May 7, 2026 •

edited

Loading